/*
 * Copyright (c) 2011-2012 Alexander Dubu
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * o  Redistributions of source code must retain the above copyright notice,
 *    this list of conditions and the following disclaimer.
 *
 * o  Redistributions in binary form must reproduce the above copyright notice,
 *    this list of conditions and the following disclaimer in the documentation
 *    and/or other materials provided with the distribution.
 *
 * o  Neither the name Axil nor the names of its contributors may be used to
 *    endorse or promote products derived from this software without specific
 *    prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */
package axil.api;

import java.util.TimeZone;


/**
 * An interface representing a persona, or user. The host application provides
 * an implementation of this interface when executing a script to enable
 * localization and custom formatting. If the concept does not apply to the
 * host application, then a generic system persona based upon Java defaults can
 * be obtained via the Axil.system() method. This interface is intended
 * to be implemented by host applications, as necessary.
 *
 * @see axil.api.Axil#system()
 */
public interface Persona {
	/**
	 * Get the locale for this persona. Locales in Axil are distinctly different
	 * from Java locales. Use the Axil.locale() method to find the Axil locale
	 * corresponding to your environment.
	 *
	 * @return
	 * 	Returns a non-null locale.
	 *
	 * @see axil.api.Axil#locale
	 */
	public Locale locale();


	/**
	 * Get the time zone associated with this persona.
	 *
	 * @return
	 * 	Returns a non-null time zone.
	 */
	public TimeZone timezone();


	/**
	 * Get the formatting preferences for this persona.
	 *
	 * @param type
	 * 	The type of object to be formatted. The type given is never null.
	 *
	 * @return
	 * 	Returns the formatting preferences for this persona for the given type.
	 * 	The object returned may be null, in which case the preferences for the
	 * 	locale will be used.
	 */
	public Formatting formatting(AxilType type);
}
